org.springframework.jdbc.support.lob

Class TemporaryLobCreator

java.lang.Object

org.springframework.jdbc.support.lob.TemporaryLobCreator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, LobCreator

public class TemporaryLobCreator
extends java.lang.Object
implements LobCreator

LobCreator implementation based on temporary LOBs, using JDBC 4.0's Connection.createBlob() / Connection.createClob() mechanism.

Used by DefaultLobHandler's DefaultLobHandler.setCreateTemporaryLob(boolean) mode. Can also be used directly to reuse the tracking and freeing of temporary LOBs.

Since:

3.2.2

Author:

Juergen Hoeller

See Also:

DefaultLobHandler.setCreateTemporaryLob(boolean), Connection.createBlob(), Connection.createClob()

Field Summary

Fields

Modifier and Type	Field and Description
protected static Log	logger
private java.util.Set<java.sql.Blob>	temporaryBlobs
private java.util.Set<java.sql.Clob>	temporaryClobs

Constructor Summary

Constructors

Constructor and Description
TemporaryLobCreator()

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Close this LobCreator session and free its temporarily created BLOBs and CLOBs.
void	setBlobAsBinaryStream(java.sql.PreparedStatement ps, int paramIndex, java.io.InputStream binaryStream, int contentLength) Set the given content as binary stream on the given statement, using the given parameter index.
void	setBlobAsBytes(java.sql.PreparedStatement ps, int paramIndex, byte[] content) Set the given content as bytes on the given statement, using the given parameter index.
void	setClobAsAsciiStream(java.sql.PreparedStatement ps, int paramIndex, java.io.InputStream asciiStream, int contentLength) Set the given content as ASCII stream on the given statement, using the given parameter index.
void	setClobAsCharacterStream(java.sql.PreparedStatement ps, int paramIndex, java.io.Reader characterStream, int contentLength) Set the given content as character stream on the given statement, using the given parameter index.
void	setClobAsString(java.sql.PreparedStatement ps, int paramIndex, java.lang.String content) Set the given content as String on the given statement, using the given parameter index.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

logger

protected static final Log logger

temporaryBlobs

private final java.util.Set<java.sql.Blob> temporaryBlobs

temporaryClobs

private final java.util.Set<java.sql.Clob> temporaryClobs

Constructor Detail

TemporaryLobCreator

public TemporaryLobCreator()

Method Detail

setBlobAsBytes

public void setBlobAsBytes(java.sql.PreparedStatement ps,
                  int paramIndex,
                  byte[] content)
                    throws java.sql.SQLException

Description copied from interface: LobCreator

Set the given content as bytes on the given statement, using the given parameter index. Might simply invoke PreparedStatement.setBytes or create a Blob instance for it, depending on the database and driver.

Specified by:

setBlobAsBytes in interface LobCreator

Parameters:

ps - the PreparedStatement to the set the content on

paramIndex - the parameter index to use

content - the content as byte array, or null for SQL NULL

Throws:

java.sql.SQLException - if thrown by JDBC methods

See Also:

PreparedStatement.setBytes(int, byte[])

setBlobAsBinaryStream

public void setBlobAsBinaryStream(java.sql.PreparedStatement ps,
                         int paramIndex,
                         java.io.InputStream binaryStream,
                         int contentLength)
                           throws java.sql.SQLException

Description copied from interface: LobCreator

Set the given content as binary stream on the given statement, using the given parameter index. Might simply invoke PreparedStatement.setBinaryStream or create a Blob instance for it, depending on the database and driver.

Specified by:

setBlobAsBinaryStream in interface LobCreator

Parameters:

ps - the PreparedStatement to the set the content on

paramIndex - the parameter index to use

binaryStream - the content as binary stream, or null for SQL NULL

Throws:

java.sql.SQLException - if thrown by JDBC methods

See Also:

PreparedStatement.setBinaryStream(int, java.io.InputStream, int)

setClobAsString

public void setClobAsString(java.sql.PreparedStatement ps,
                   int paramIndex,
                   java.lang.String content)
                     throws java.sql.SQLException

Description copied from interface: LobCreator

Set the given content as String on the given statement, using the given parameter index. Might simply invoke PreparedStatement.setString or create a Clob instance for it, depending on the database and driver.

Specified by:

setClobAsString in interface LobCreator

Parameters:

ps - the PreparedStatement to the set the content on

paramIndex - the parameter index to use

content - the content as String, or null for SQL NULL

Throws:

java.sql.SQLException - if thrown by JDBC methods

See Also:

PreparedStatement.setBytes(int, byte[])

setClobAsAsciiStream

public void setClobAsAsciiStream(java.sql.PreparedStatement ps,
                        int paramIndex,
                        java.io.InputStream asciiStream,
                        int contentLength)
                          throws java.sql.SQLException

Description copied from interface: LobCreator

Set the given content as ASCII stream on the given statement, using the given parameter index. Might simply invoke PreparedStatement.setAsciiStream or create a Clob instance for it, depending on the database and driver.

Specified by:

setClobAsAsciiStream in interface LobCreator

Parameters:

ps - the PreparedStatement to the set the content on

paramIndex - the parameter index to use

asciiStream - the content as ASCII stream, or null for SQL NULL

Throws:

java.sql.SQLException - if thrown by JDBC methods

See Also:

PreparedStatement.setAsciiStream(int, java.io.InputStream, int)

setClobAsCharacterStream

public void setClobAsCharacterStream(java.sql.PreparedStatement ps,
                            int paramIndex,
                            java.io.Reader characterStream,
                            int contentLength)
                              throws java.sql.SQLException

Description copied from interface: LobCreator

Set the given content as character stream on the given statement, using the given parameter index. Might simply invoke PreparedStatement.setCharacterStream or create a Clob instance for it, depending on the database and driver.

Specified by:

setClobAsCharacterStream in interface LobCreator

Parameters:

ps - the PreparedStatement to the set the content on

paramIndex - the parameter index to use

characterStream - the content as character stream, or null for SQL NULL

Throws:

java.sql.SQLException - if thrown by JDBC methods

See Also:

PreparedStatement.setCharacterStream(int, java.io.Reader, int)

close

public void close()

Description copied from interface: LobCreator

Close this LobCreator session and free its temporarily created BLOBs and CLOBs. Will not need to do anything if using PreparedStatement's standard methods, but might be necessary to free database resources if using proprietary means.

NOTE: Needs to be invoked after the involved PreparedStatements have been executed or the affected O/R mapping sessions have been flushed. Otherwise, the database resources for the temporary BLOBs might stay allocated.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface LobCreator